Sets the highlight state of the window’s structure region to reflect the window’s validity as a drag-and-drop destination.

OSStatus HiliteWindowFrameForDrag (
    WindowRef window, 
    Boolean hilited
);

window

A pointer to the window for which you wish to set the highlight state.

hilited

true if the window’s frame should be highlighted; otherwise, false.

function result

A result code.

DISCUSSION

Applications typically call the Drag Manager functions ShowDragHilite and HideDragHilite to indicate that a window is a valid drag-and-drop destination. If your application does not do this—that is, if your application implements any type of custom drag highlighting, such as highlighting more than one area of a window at a time—it must call the HiliteWindowFrameForDrag function.

The HiliteWindowFrameForDrag function highlights a window’s proxy icon when the user drags content inside the window that is a valid content type for that destination. The default behavior of system-defined windows is to highlight the proxy icon along with the window’s content area when the window is a valid drag-and-drop destination. If you call the Drag Manager functions ShowDragHilite and HideDragHilite, you don’t need to use HiliteWindowFrameForDrag.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when WindowsLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by WindowsLib 8.5 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)